<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title></title>
  <link rel="stylesheet" href="media/stylesheet.css" />
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><a name="top"></a>
<h2>Element Index, Package  lucene-silverstripe-module</h2>
<ul>
</ul>
<a href="elementindex.html"><strong>Index of all elements</strong></a>
<br />
	<a href="elementindex_lucene-silverstripe-module.html#a">a</a>
	<a href="elementindex_lucene-silverstripe-module.html#b">b</a>
	<a href="elementindex_lucene-silverstripe-module.html#c">c</a>
	<a href="elementindex_lucene-silverstripe-module.html#d">d</a>
	<a href="elementindex_lucene-silverstripe-module.html#e">e</a>
	<a href="elementindex_lucene-silverstripe-module.html#f">f</a>
	<a href="elementindex_lucene-silverstripe-module.html#g">g</a>
	<a href="elementindex_lucene-silverstripe-module.html#i">i</a>
	<a href="elementindex_lucene-silverstripe-module.html#k">k</a>
	<a href="elementindex_lucene-silverstripe-module.html#m">m</a>
	<a href="elementindex_lucene-silverstripe-module.html#o">o</a>
	<a href="elementindex_lucene-silverstripe-module.html#p">p</a>
	<a href="elementindex_lucene-silverstripe-module.html#r">r</a>
	<a href="elementindex_lucene-silverstripe-module.html#s">s</a>
	<a href="elementindex_lucene-silverstripe-module.html#t">t</a>
	<a href="elementindex_lucene-silverstripe-module.html#u">u</a>
	<a href="elementindex_lucene-silverstripe-module.html#z">z</a>
	<a href="elementindex_lucene-silverstripe-module.html#_">_</a>

<br /><br />
<table border="0" width="100%">
<thead>
  <tr>
    <td><strong>_</strong></td>
    <td align='right'><a name="_">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$_classConfig</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$_classConfig">ZendSearchLuceneSearchable::$_classConfig</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The raw string used to configure the object.  We have to store it and parse  it on first use at runtime, because the owner of the decorator isn't set in  the constructor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$_fieldConfig</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$_fieldConfig">ZendSearchLuceneSearchable::$_fieldConfig</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The raw string used to configure the object's fields.  We have to store it and parse  it on first use at runtime, because the owner of the decorator isn't set in  the constructor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>__construct</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#method__construct">ZendSearchLuceneSearchable::__construct()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Called by the system when initialising each instance of the decorated  class.  The argument comes from the Object::add_extension call in the  project's _config.php file.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>__construct</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneForm.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneForm.html#method__construct">ZendSearchLuceneForm::__construct()</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>a</strong></td>
    <td align='right'><a name="a">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$allowed_actions</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneCMSDecorator.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneCMSDecorator.html#var$allowed_actions">ZendSearchLuceneCMSDecorator::$allowed_actions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Enables the extra button added via ZendSearchLuceneSiteConfig.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$allowed_actions</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneContentController.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneContentController.html#var$allowed_actions">ZendSearchLuceneContentController::$allowed_actions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Enables the search form to talk to the controller.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$alwaysShowPages</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$alwaysShowPages">ZendSearchLuceneSearchable::$alwaysShowPages</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Always show this many pages in pagination (can be zero)</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>addCreateIndexCallback</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#methodaddCreateIndexCallback">ZendSearchLuceneWrapper::addCreateIndexCallback()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Register a callback to run when creating an index.  Useful for setting  advanced index options.  For example:</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>b</strong></td>
    <td align='right'><a name="b">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$binary_location</strong></td>
    <td width="100%" align="left" valign="top">in file PdfDocumentExtractor.php, variable <a href="lucene-silverstripe-module/PdfDocumentExtractor.html#var$binary_location">PdfDocumentExtractor::$binary_location</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Holds the location of the pdftotext binary.  Should be a full filesystem  path.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$binary_location</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocXlsExtractor.php, variable <a href="lucene-silverstripe-module/CatdocXlsExtractor.html#var$binary_location">CatdocXlsExtractor::$binary_location</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Holds the location of the xls2csv binary.  Should be a full filesystem  path.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$binary_location</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocPptExtractor.php, variable <a href="lucene-silverstripe-module/CatdocPptExtractor.html#var$binary_location">CatdocPptExtractor::$binary_location</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Holds the location of the xls2csv binary.  Should be a full filesystem  path.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$binary_location</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocDocExtractor.php, variable <a href="lucene-silverstripe-module/CatdocDocExtractor.html#var$binary_location">CatdocDocExtractor::$binary_location</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Holds the location of the catdoc binary.  Should be a full filesystem  path.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>c</strong></td>
    <td align='right'><a name="c">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$cacheDirectory</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$cacheDirectory">ZendSearchLuceneSearchable::$cacheDirectory</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Full filesystem path to the directory where the index files should live</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$classConfig</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$classConfig">ZendSearchLuceneSearchable::$classConfig</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The config options for this DataObject class.  This is not public, and  should be set by configuring the class via the Object::add_extension argument.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CatdocDocExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocDocExtractor.php, class <a href="lucene-silverstripe-module/CatdocDocExtractor.html">CatdocDocExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from a DOC format Microsoft Word document.  Uses the catdoc  command-line utility to do so.  Catdoc can be downloaded for Linux at:</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CatdocPptExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocPptExtractor.php, class <a href="lucene-silverstripe-module/CatdocPptExtractor.html">CatdocPptExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from a PPT format Microsoft Powerpoint document.  Uses the  catppt command-line utility to do so.  This utility is part of the catdoc  suite of command-line utilities, which can be downloaded at:</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CatdocXlsExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocXlsExtractor.php, class <a href="lucene-silverstripe-module/CatdocXlsExtractor.html">CatdocXlsExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from an XLS format Microsoft Excel document.  Uses the xls2csv  command-line utility to do so.  This utility is part of the catdoc suite of  command-line utilities, which can be downloaded at:</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>commandline</strong></td>
    <td width="100%" align="left" valign="top">in file PdfDocumentExtractor.php, method <a href="lucene-silverstripe-module/PdfDocumentExtractor.html#methodcommandline">PdfDocumentExtractor::commandline()</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CatdocDocExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---CatdocDocExtractor.php.html">CatdocDocExtractor.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CatdocPptExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---CatdocPptExtractor.php.html">CatdocPptExtractor.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>CatdocXlsExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---CatdocXlsExtractor.php.html">CatdocXlsExtractor.php</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>d</strong></td>
    <td align='right'><a name="d">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$defaultColumns</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$defaultColumns">ZendSearchLuceneSearchable::$defaultColumns</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Default fields to index for each Searchable decorated class.  This isn't  public - it's just a convenience thing, for those people who just want to  get up and running with indexing SiteTree and File with minimum  configuration.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>delete</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#methoddelete">ZendSearchLuceneWrapper::delete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Delete a DataObject from the search index.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>e</strong></td>
    <td align='right'><a name="e">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$encoding</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$encoding">ZendSearchLuceneSearchable::$encoding</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Encoding in which indexes are created and searches made.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file TxtDocumentExtractor.php, variable <a href="lucene-silverstripe-module/TxtDocumentExtractor.html#var$extensions">TxtDocumentExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneDocxExtractor.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneDocxExtractor.html#var$extensions">ZendSearchLuceneDocxExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneHtmlExtractor.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneHtmlExtractor.html#var$extensions">ZendSearchLuceneHtmlExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLucenePptxExtractor.php, variable <a href="lucene-silverstripe-module/ZendSearchLucenePptxExtractor.html#var$extensions">ZendSearchLucenePptxExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocDocExtractor.php, variable <a href="lucene-silverstripe-module/CatdocDocExtractor.html#var$extensions">CatdocDocExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneTextExtractor.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneTextExtractor.html#var$extensions">ZendSearchLuceneTextExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;An array of strings representing file extensions that can be handled by  this TextExtractor.  Do not include a dot in your extensions.  Extensions  should be in lower case, and will detect all case variations on scanned  files.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneXlsxExtractor.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneXlsxExtractor.html#var$extensions">ZendSearchLuceneXlsxExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocPptExtractor.php, variable <a href="lucene-silverstripe-module/CatdocPptExtractor.html#var$extensions">CatdocPptExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file PdfDocumentExtractor.php, variable <a href="lucene-silverstripe-module/PdfDocumentExtractor.html#var$extensions">PdfDocumentExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extensions</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocXlsExtractor.php, variable <a href="lucene-silverstripe-module/CatdocXlsExtractor.html#var$extensions">CatdocXlsExtractor::$extensions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The extensions that can be handled by this text extractor.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$extraSearchFields</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$extraSearchFields">ZendSearchLuceneSearchable::$extraSearchFields</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Fields which are also indexed in addition to content fields.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>enable</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodenable">ZendSearchLuceneSearchable::enable()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Enable the default configuration of Zend Search Lucene searching on the  given data classes.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneXlsxExtractor.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneXlsxExtractor.html#methodextract">ZendSearchLuceneXlsxExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given Microsoft Excel XLSX  document.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneTextExtractor.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneTextExtractor.html#methodextract">ZendSearchLuceneTextExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns text for a given full filesystem path.  If a file cannot be  processed, you should return an empty string.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneDocxExtractor.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneDocxExtractor.html#methodextract">ZendSearchLuceneDocxExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given Microsoft Word DOCX  document.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocPptExtractor.php, method <a href="lucene-silverstripe-module/CatdocPptExtractor.html#methodextract">CatdocPptExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given Microsoft Powerpoint  PPT document.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocDocExtractor.php, method <a href="lucene-silverstripe-module/CatdocDocExtractor.html#methodextract">CatdocDocExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given Microsoft Word DOC  document.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocXlsExtractor.php, method <a href="lucene-silverstripe-module/CatdocXlsExtractor.html#methodextract">CatdocXlsExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given Microsoft Excel XLS  document.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file PdfDocumentExtractor.php, method <a href="lucene-silverstripe-module/PdfDocumentExtractor.html#methodextract">PdfDocumentExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given TXT document.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneHtmlExtractor.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneHtmlExtractor.html#methodextract">ZendSearchLuceneHtmlExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given HTML document.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file TxtDocumentExtractor.php, method <a href="lucene-silverstripe-module/TxtDocumentExtractor.html#methodextract">TxtDocumentExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given TXT document.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>extract</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLucenePptxExtractor.php, method <a href="lucene-silverstripe-module/ZendSearchLucenePptxExtractor.html#methodextract">ZendSearchLucenePptxExtractor::extract()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the text in the given Microsoft Word PPTX  document.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>f</strong></td>
    <td align='right'><a name="f">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$fieldConfig</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$fieldConfig">ZendSearchLuceneSearchable::$fieldConfig</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The fields which can be searched for each DataObject class, and indexing  info for each field.  This is not public, and should be set by configuring  the class via the Object::add_extension argument.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>find</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#methodfind">ZendSearchLuceneWrapper::find()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a set of results from Zend Search Lucene from the given search  parameters.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>forTemplate</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneForm.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneForm.html#methodforTemplate">ZendSearchLuceneForm::forTemplate()</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>g</strong></td>
    <td align='right'><a name="g">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getAllIndexableObjects</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#methodgetAllIndexableObjects">ZendSearchLuceneWrapper::getAllIndexableObjects()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a data array of all indexable DataObjects.  For use when reindexing.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getDataArrayFromHits</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneContentController.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneContentController.html#methodgetDataArrayFromHits">ZendSearchLuceneContentController::getDataArrayFromHits()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a data array suitable for customising a Page with, containing  search result and pagination information.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getExtraSearchFields</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodgetExtraSearchFields">ZendSearchLuceneSearchable::getExtraSearchFields()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get an array of the class' extra search fieldnames that are indexed but  not searched.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getFieldValue</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#methodgetFieldValue">ZendSearchLuceneWrapper::getFieldValue()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Function to reduce a nested dot-notated field name to a string value.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getIndex</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#methodgetIndex">ZendSearchLuceneWrapper::getIndex()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Retrieves a Zend_Search_Lucene_Interface object connected to the search  index.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getLuceneClassConfig</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodgetLuceneClassConfig">ZendSearchLuceneSearchable::getLuceneClassConfig()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the class config array.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getLuceneFieldConfig</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodgetLuceneFieldConfig">ZendSearchLuceneSearchable::getLuceneFieldConfig()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the field config array for a given field.  Throws a user_error if  the field doesn't exist in the config.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getSearchedVars</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodgetSearchedVars">ZendSearchLuceneSearchable::getSearchedVars()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Return an array of search field names.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getSearchFields</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodgetSearchFields">ZendSearchLuceneSearchable::getSearchFields()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get an array of the class' searched fieldnames from other classes.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getSignature</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneReindexJob.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneReindexJob.html#methodgetSignature">ZendSearchLuceneReindexJob::getSignature()</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>getTitle</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneReindexJob.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneReindexJob.html#methodgetTitle">ZendSearchLuceneReindexJob::getTitle()</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>get_binary_path</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocXlsExtractor.php, method <a href="lucene-silverstripe-module/CatdocXlsExtractor.html#methodget_binary_path">CatdocXlsExtractor::get_binary_path()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Try to detect where the xls2csv binary has been installed.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>get_binary_path</strong></td>
    <td width="100%" align="left" valign="top">in file PdfDocumentExtractor.php, method <a href="lucene-silverstripe-module/PdfDocumentExtractor.html#methodget_binary_path">PdfDocumentExtractor::get_binary_path()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Try to detect where the pdftptext binary has been installed.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>get_binary_path</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocDocExtractor.php, method <a href="lucene-silverstripe-module/CatdocDocExtractor.html#methodget_binary_path">CatdocDocExtractor::get_binary_path()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Try to detect where the catdoc binary has been installed.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>get_binary_path</strong></td>
    <td width="100%" align="left" valign="top">in file CatdocPptExtractor.php, method <a href="lucene-silverstripe-module/CatdocPptExtractor.html#methodget_binary_path">CatdocPptExtractor::get_binary_path()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Try to detect where the catppt binary has been installed.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>i</strong></td>
    <td align='right'><a name="i">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$indexName</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#var$indexName">ZendSearchLuceneWrapper::$indexName</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The name of the index.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>index</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#methodindex">ZendSearchLuceneWrapper::index()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Indexes a DataObject.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>k</strong></td>
    <td align='right'><a name="k">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$keyword_fields</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$keyword_fields">ZendSearchLuceneSearchable::$keyword_fields</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Fields which should be indexed as 'keyword' by default.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>m</strong></td>
    <td align='right'><a name="m">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$maxShowPages</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$maxShowPages">ZendSearchLuceneSearchable::$maxShowPages</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Maximum number of pages shown in pagination (ellipsis are used to indicate more pages)</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>o</strong></td>
    <td align='right'><a name="o">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>onAfterDelete</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodonAfterDelete">ZendSearchLuceneSearchable::onAfterDelete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Removes the object from the search index after it has been deleted.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>onAfterWrite</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodonAfterWrite">ZendSearchLuceneSearchable::onAfterWrite()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Indexes the object after it has been written to the database.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>p</strong></td>
    <td align='right'><a name="p">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$pageLength</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$pageLength">ZendSearchLuceneSearchable::$pageLength</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Number of results per pagination page</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$priority</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneTextExtractor.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneTextExtractor.html#var$priority">ZendSearchLuceneTextExtractor::$priority</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Controls the order in which text extractor classes are tried for a  specific file extension.  Default is 100.  To make your custom extractor  run before an inbuilt one, set this to less than 100, or to make it run  afterwards set it to more than 100.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>pdf2text</strong></td>
    <td width="100%" align="left" valign="top">in file PdfDocumentExtractor.php, method <a href="lucene-silverstripe-module/PdfDocumentExtractor.html#methodpdf2text">PdfDocumentExtractor::pdf2text()</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>PdfDocumentExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file PdfDocumentExtractor.php, class <a href="lucene-silverstripe-module/PdfDocumentExtractor.html">PdfDocumentExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from a PDF document.  Tries to use the pdftotext command-line  utility if it is installed, otherwise falls back to the PDF2Text class.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>process</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneReindexJob.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneReindexJob.html#methodprocess">ZendSearchLuceneReindexJob::process()</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>PdfDocumentExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---PdfDocumentExtractor.php.html">PdfDocumentExtractor.php</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>r</strong></td>
    <td align='right'><a name="r">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$reindexOnDevBuild</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$reindexOnDevBuild">ZendSearchLuceneSearchable::$reindexOnDevBuild</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Boolean indicating whether we should rebuild the index whenever a  dev/build is run.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>rebuildIndex</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html#methodrebuildIndex">ZendSearchLuceneWrapper::rebuildIndex()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Rebuilds the search index.  Generally called via register_shutdown_function().</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>rebuildZendSearchLuceneIndex</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneCMSDecorator.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneCMSDecorator.html#methodrebuildZendSearchLuceneIndex">ZendSearchLuceneCMSDecorator::rebuildZendSearchLuceneIndex()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Receives the form submission which tells the index rebuild process to  begin.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>reindex</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneCMSDecorator.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneCMSDecorator.html#methodreindex">ZendSearchLuceneCMSDecorator::reindex()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Debug method to allow manual reindexing with output via the URL  /Lucene/reindex</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>requireDefaultRecords</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#methodrequireDefaultRecords">ZendSearchLuceneSearchable::requireDefaultRecords()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Rebuilds the search index whenever a dev/build is run.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>results</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneContentController.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneContentController.html#methodresults">ZendSearchLuceneContentController::results()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Wrapper around ZendSearchLuceneResults, for when we are using $SearchForm  in templates.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>s</strong></td>
    <td align='right'><a name="s">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>SearchForm</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneContentController.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneContentController.html#methodSearchForm">ZendSearchLuceneContentController::SearchForm()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Makes $SearchForm included in many stock templates return a Lucene form  analogous to the one that the FulltextSearchable extension outputs. Uses  the SearchForm.ss template that comes with Sapphire (or an overridden  custom version if one is available, as per the regular SearchForm).</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>SearchTextHighlight</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneTextHighlightDecorator.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneTextHighlightDecorator.html#methodSearchTextHighlight">ZendSearchLuceneTextHighlightDecorator::SearchTextHighlight()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a part of the field's text with a word or words highlighted.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>setup</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneReindexJob.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneReindexJob.html#methodsetup">ZendSearchLuceneReindexJob::setup()</a></td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>t</strong></td>
    <td align='right'><a name="t">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>TxtDocumentExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---TxtDocumentExtractor.php.html">TxtDocumentExtractor.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>TxtDocumentExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file TxtDocumentExtractor.php, class <a href="lucene-silverstripe-module/TxtDocumentExtractor.html">TxtDocumentExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from a TXT text document.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>u</strong></td>
    <td align='right'><a name="u">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$unindexed_fields</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$unindexed_fields">ZendSearchLuceneSearchable::$unindexed_fields</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Fields which should be indexed as 'unindexed' by default.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>$unstored_fields</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, variable <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html#var$unstored_fields">ZendSearchLuceneSearchable::$unstored_fields</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Fields which should be indexed as 'unstored' by default.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>updateCMSActions</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSiteConfig.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneSiteConfig.html#methodupdateCMSActions">ZendSearchLuceneSiteConfig::updateCMSActions()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds a button the Site Config page of the CMS to rebuild the Lucene search index.</td>
  </tr>
  </tbody>
<thead>
  <tr>
    <td><strong>z</strong></td>
    <td align='right'><a name="z">&nbsp; </a>
                      <a href="#top">top</a><br /></td>
  </tr>
</thead>
<tbody>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneDocxExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---ZendSearchLuceneDocxExtractor.php.html">ZendSearchLuceneDocxExtractor.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneHtmlExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---ZendSearchLuceneHtmlExtractor.php.html">ZendSearchLuceneHtmlExtractor.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLucenePptxExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---ZendSearchLucenePptxExtractor.php.html">ZendSearchLucenePptxExtractor.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneTextExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---ZendSearchLuceneTextExtractor.php.html">ZendSearchLuceneTextExtractor.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneXlsxExtractor.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_TextExtractors---ZendSearchLuceneXlsxExtractor.php.html">ZendSearchLuceneXlsxExtractor.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneCMSDecorator</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneCMSDecorator.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneCMSDecorator.html">ZendSearchLuceneCMSDecorator</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds functions to LeftAndMain to rebuild the Lucene search index.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneCMSDecorator.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_ZendSearchLuceneCMSDecorator.php.html">ZendSearchLuceneCMSDecorator.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneContentController</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneContentController.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneContentController.html">ZendSearchLuceneContentController</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extension to provide a search interface when applied to ContentController.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneContentController.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_ZendSearchLuceneContentController.php.html">ZendSearchLuceneContentController.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneDocxExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneDocxExtractor.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneDocxExtractor.html">ZendSearchLuceneDocxExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from a DOCX format Microsoft Word document.  Uses the Zend  text extraction class to do so.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneForm</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneContentController.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneContentController.html#methodZendSearchLuceneForm">ZendSearchLuceneContentController::ZendSearchLuceneForm()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the Lucene-powered search Form object.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneForm</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneForm.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneForm.html">ZendSearchLuceneForm</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The search form.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneForm.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_ZendSearchLuceneForm.php.html">ZendSearchLuceneForm.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneHtmlExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneHtmlExtractor.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneHtmlExtractor.html">ZendSearchLuceneHtmlExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from an HTML document.  Uses the Zend HTML text extraction  class to do so.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLucenePptxExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLucenePptxExtractor.php, class <a href="lucene-silverstripe-module/ZendSearchLucenePptxExtractor.html">ZendSearchLucenePptxExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from a PPTX format Microsoft Powerpoint document.  Uses the  Zend text extraction class to do so.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneReindexJob</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneReindexJob.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneReindexJob.html">ZendSearchLuceneReindexJob</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The job description class for reindexing the search index via the Queued Jobs  SilverStripe module.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneReindexJob.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_ZendSearchLuceneReindexJob.php.html">ZendSearchLuceneReindexJob.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneResults</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneContentController.php, method <a href="lucene-silverstripe-module/ZendSearchLuceneContentController.html#methodZendSearchLuceneResults">ZendSearchLuceneContentController::ZendSearchLuceneResults()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Process and render search results. Uses the Lucene_results.ss template to  render the form.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneSearchable</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSearchable.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneSearchable.html">ZendSearchLuceneSearchable</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Decorates a DataObject, giving it the ability to be indexed and searched by  Zend_Search_Lucene.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneSearchable.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_ZendSearchLuceneSearchable.php.html">ZendSearchLuceneSearchable.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneSiteConfig</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneSiteConfig.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneSiteConfig.html">ZendSearchLuceneSiteConfig</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds a button the Site Config page of the CMS to rebuild the Lucene search index.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneSiteConfig.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_ZendSearchLuceneSiteConfig.php.html">ZendSearchLuceneSiteConfig.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneTextExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneTextExtractor.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneTextExtractor.html">ZendSearchLuceneTextExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Abstract base class instructing the Lucene module on how to extract text from a  given file type.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneTextHighlightDecorator</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneTextHighlightDecorator.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneTextHighlightDecorator.html">ZendSearchLuceneTextHighlightDecorator</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extension to StringField to add a Field.SearchTextHighlight template method  that extracts text for a given search term.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneTextHighlightDecorator.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_ZendSearchLuceneTextHighlightDecorator.php.html">ZendSearchLuceneTextHighlightDecorator.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneWrapper</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneWrapper.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneWrapper.html">ZendSearchLuceneWrapper</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Provides a wrapper to Zend Search Lucene.</td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneWrapper.php</strong></td>
    <td width="100%" align="left" valign="top">procedural page <a href="lucene-silverstripe-module/_ZendSearchLuceneWrapper.php.html">ZendSearchLuceneWrapper.php</a></td>
  </tr>
    <tr>
    <td>&nbsp;&nbsp;&nbsp;<strong>ZendSearchLuceneXlsxExtractor</strong></td>
    <td width="100%" align="left" valign="top">in file ZendSearchLuceneXlsxExtractor.php, class <a href="lucene-silverstripe-module/ZendSearchLuceneXlsxExtractor.html">ZendSearchLuceneXlsxExtractor</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Extracts text from a XLSX format Microsoft Excel document.  Uses the Zend  text extraction class to do so.</td>
  </tr>
  </tbody>
</table></body>
</html>